home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / programs / rtfdc110.zip / RTFDC.DOC < prev    next >
Text File  |  1993-04-20  |  20KB  |  574 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                   RBBS Turbo FMS Dupe Checker  Version 1.10 (RTFDC)
  20.                Copyright 1992 by Walter C. Ames.  All rights reserved.
  21.                                 Created July 5, 1992
  22.  
  23.  
  24.  
  25.  
  26.  
  27.    ╓───────────────────────────────────────────────────────────────────────╖
  28.    ║                            TABLE OF CONTENTS                          ║
  29.    ╙───────────────────────────────────────────────────────────────────────╜
  30.  
  31.  
  32.  
  33.  
  34.    License/Warranty/Registration . . . . . . . . . . . . . . . . . . . . 1
  35.      License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
  36.      Warranty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
  37.      Registration. . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
  38.  
  39.  
  40.    Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  41.      About RTFDC . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  42.      RTFDC Features. . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  43.      Kudos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
  44.  
  45.  
  46.    Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
  47.      System Requirements . . . . . . . . . . . . . . . . . . . . . . . . 3
  48.  
  49.  
  50.    Command Line Syntax/Usage . . . . . . . . . . . . . . . . . . . . . . 4
  51.  
  52.  
  53.    Creating Your Configuration File. . . . . . . . . . . . . . . . . . . 4
  54.  
  55.  
  56.    RTFDC Report File . . . . . . . . . . . . . . . . . . . . . . . . . . 7
  57.  
  58.    Appendix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
  59.      Problem Reporting . . . . . . . . . . . . . . . . . . . . . . . . . 8
  60.  
  61.  
  62.  
  63.  
  64.    ■ RBBS-PC Turbo FMS Duplicate Checker v1.10                            1
  65.    ──────────────────────────────────────────────────────────────────────────
  66.  
  67.    ╓───────────────────────────────────────────────────────────────────────╖
  68.    ║                    LICENSE - WARRANTY - REGISTRATION                  ║
  69.    ╙───────────────────────────────────────────────────────────────────────╜
  70.  
  71.    Distribution and/or use is permitted under the following terms:
  72.  
  73.    You may copy and distribute verbatim copies of the RTFDC documentation
  74.    and executable code as you receive it, in any medium, provided that you
  75.    conspicuously and appropriately publish on each copy a valid copyright
  76.    notice "Copyright 1992 by Walter C. Ames"; keep intact the notices on all
  77.    files that refer to this license agreement and to the absence of any
  78.    warranty.  PROVIDE UNMODIFIED COPIES OF THE DOCUMENTATION AS PROVIDED
  79.    WITH THE PROGRAM; and give any of the other recipients of the RTFDC
  80.    program a copy of this license agreement along with the program.  You may
  81.    charge a distribution fee for the physical act of transferring a copy,
  82.    but no more than is necessary to recover your actual costs incurred in
  83.    the transfer. Under no circumstances is RTFDC to be distributed in such a
  84.    way as to be construed as "value added" in a sales transaction, such as,
  85.    but not limited to, software bundled with a modem or CD-ROM software
  86.    collections, without the prior written consent of the author.
  87.  
  88.                                     Warranty
  89.  
  90.    THIS PRODUCT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, INCLUDING
  91.    ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  THE
  92.    ENTIRE RISK AS TO THE RESULTS AND PERFORMANCE OF THIS PROGRAM IS ASSUMED
  93.    BY YOU. FURTHERMORE, I THE AUTHOR DO NOT WARRANT, GUARANTEE, OR MAKE ANY
  94.    REPRESENTATIONS REGARDING THE USE OF OR THE RESULTS OF THE USE OF THE
  95.    PROGRAM, OR THAT THE PROGRAM WILL RUN WITHOUT ERROR, AND YOU RELY ON THE
  96.    PROGRAM AND RESULTS SOLELY AT YOUR OWN RISK.  I THE AUTHOR CANNOT ACCEPT
  97.    RESPONSIBILITY FOR SYSTEM DAMAGE, LOSS OF PROFIT, OR ANY OTHER SPECIAL,
  98.    INCIDENTAL, OR CONSEQUENTIAL DAMAGES RESULTING FROM THE USE OR INABILITY
  99.    TO USE THIS PRODUCT.
  100.  
  101.                                   Registration
  102.  
  103.    This program is being released under the "FREEWARE" concept.  This means
  104.    that the program is "JUST FREE" no strings attached.  You may use it for
  105.    as long as you like or delete it right away.  If you enjoy the program
  106.    and feel that you must do something then please consider donating to
  107.    the charity of your choice.  I'm just one for good causes :-)  By no
  108.    means is the above mandatory, simply a suggestion.
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.    
  126.  
  127.  
  128.    ■ RBBS-PC Turbo FMS Duplicate Checker v1.10                            2
  129.    ──────────────────────────────────────────────────────────────────────────
  130.  
  131.    ╓───────────────────────────────────────────────────────────────────────╖
  132.    ║                              INTRODUCTION                             ║
  133.    ╙───────────────────────────────────────────────────────────────────────╜
  134.  
  135.  
  136.                                    About RTFDC
  137.  
  138.    RTFDC is a full featured RBBS File Management System (FMS) Duplicate
  139.    Checker.  When set-up properly and used regularly it can aid in
  140.    maintaining your RBBS File Management System.  RTFDC has the ability to
  141.    generate reports based on several different FMS conditions and is
  142.    completely configurable.
  143.  
  144.  
  145.  
  146.                                 RTFDC's Features
  147.  
  148.       ■  Complete configurability.
  149.       ■  Works with any size FMS.
  150.       ■  Works with Chained FMS directories.
  151.       ■  Works with Multiple FMS directories.
  152.       ■  Handles up to 400 Downloadable DOS Sub Directories.
  153.       ■  Creates formatted reports based on runtime requests.
  154.       ■  Creates a list of all duplicate FMS entries.
  155.       ■  Creates a list of all duplicate entries on disk.
  156.       ■  Creates a list of all files in the FMS but not on the Disk(s).
  157.       ■  Creates a list of all files on the Disk(s) but not in the FMS.
  158.       ■  Creates a list of all possible duplicate file versions on the disk.
  159.       ■  Five levels of processing.
  160.       ■  User definable Sorting utility.
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.    
  190.  
  191.  
  192.    ■ RBBS-PC Turbo FMS Duplicate Checker v1.10                            3
  193.    ──────────────────────────────────────────────────────────────────────────
  194.  
  195.    ╓───────────────────────────────────────────────────────────────────────╖
  196.    ║                                  Kudos                                ║
  197.    ╙───────────────────────────────────────────────────────────────────────╜
  198.  
  199.    I would like to take this opportunity to give special thanks to those
  200.    individuals who contributed to the development of RTFDC.  Their names are
  201.    listed alphabetically below.
  202.  
  203.    Tom Collins            MSFA                        (410)536-1935
  204.    Dan Shore              The ShoreLine BBS           (301)946-2771
  205.    Larry Tyler            Games & Graphics            (301)672-5360
  206.  
  207.  
  208.    ╓───────────────────────────────────────────────────────────────────────╖
  209.    ║                         INSTALLATION PROCEDURES                       ║
  210.    ╙───────────────────────────────────────────────────────────────────────╜
  211.  
  212.                                   Assumptions
  213.  
  214.    Three basic assumption are made:
  215.  
  216.      1)   You are an RBBS-PC SysOp with an operational RBBS installation.
  217.      2)   You are familiar with the operation of DOS and RBBS.
  218.      3)   You would like to test your File database for duplicates.
  219.  
  220.                                System Requirements
  221.  
  222.    Although RTFDC was designed to be as generic as possible, the following
  223.    system configuration is required as a minimum:
  224.  
  225.      1)   An IBM PC, XT, AT, PS/2, or a 100% compatible.
  226.      2)   MS/PC-DOS 3.1 or above.
  227.      3)   A text file sorting utility such as QSort or Sortf.  Any sorting
  228.           utility that is capable of sorting a text file the size of your FMS
  229.           and accepts the command line parameters <infile> <outfile> should
  230.           work.  The DOS sort program will NOT work with RTFDC.
  231.  
  232.                               Installation Summary
  233.  
  234.      1)   Read the documentation to become familiar with options.
  235.      3)   Determine the configuration options to be used.
  236.      4)   Edit the parameters in the sample configuration file to reflect
  237.           your systems needs or create a new configuration file.
  238.      5)   Run RTFDC.
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.    
  254.  
  255.  
  256.    ■ RBBS-PC Turbo FMS Duplicate Checker v1.10                            4
  257.    ──────────────────────────────────────────────────────────────────────────
  258.  
  259.    ╓───────────────────────────────────────────────────────────────────────╖
  260.    ║                        COMMAND LINE SYNTAX/USAGE                      ║
  261.    ╙───────────────────────────────────────────────────────────────────────╜
  262.  
  263.    The general format for RTFDC is:
  264.  
  265.         RTFDC <Config_File> <Output_FileName>
  266.  
  267.  
  268.    RTFDC will automagicaly search the current directory for the file
  269.    'RTFDC.CFG', if this file is present RTFDC will use it to obtain it's
  270.    configuration information.  If the default configuration file is not
  271.    present in the current directory RTFDC will display a help screen.
  272.  
  273.    You may optionally pass RTFDC a configuration file of your choice
  274.    (provided it is in the RTFDC format) enabling you to run RTFDC with
  275.    several configurations.
  276.  
  277.    RTFDC's default output report filename is RTFDC.DUP which can also be
  278.    specified on the commandline.  If you wish to tell RTFDC to use a
  279.    different report filename you must also pass it a configuration filename.
  280.  
  281.  
  282.    ╓───────────────────────────────────────────────────────────────────────╖
  283.    ║                    CREATING YOUR CONFIGURATION FILE                   ║
  284.    ╙───────────────────────────────────────────────────────────────────────╜
  285.  
  286.    The RTFDC configuration file is merely an ASCII text file.  It uses a
  287.    series of Keywords that define the parameters and file paths you wish to
  288.    use.  The Keywords can be placed in any order and in any case.  The
  289.    Keywords must begin in column 1 of the line they reside on to be
  290.    effective, otherwise they are ignored as comments.  Any line beginning
  291.    with a semi-colon or a space is considered a comment.  Blank lines are
  292.    also ignored.
  293.  
  294.    The Following is a list of Valid Keywords:
  295.  
  296.      Mandatory Keywords:  These are keywords that must be included in an
  297.        RTFDC configuration file.  If any of the following keywords are
  298.        omitted RTFDC will terminate with an error condition.
  299.  
  300.      FMS_Directory   - Full Path and FileName to the FMS Directory(s).
  301.      FIDX_Def        - Full Path and FileName to the FIDX.DEF File.
  302.      LIDX_Def        - Full Path and FileName to the LIDX.DEF File.
  303.      Sort_Prog       - Full Path and FileName to the Sorting Util.
  304.  
  305.    1.  FMS_Directory    (Max - 50)
  306.  
  307.        The 'FMS_Directory' Keyword is used to define the full name and  path
  308.        of the  FMS directory to be processed.  If "Chained" type directories
  309.        are being used RTFDC will process all Chains.  RTFDC will process  up
  310.        to 50 FMS Directories.  This includes "Chains".  Each FMS directory
  311.        you wish to process must have it's own keyword.
  312.  
  313.        Ex. FMS_Directory   C:\Rbbs\Dirr\Master.Dir
  314.  
  315.            If the file 'MASTER.DIR' chains to 3 other FMS directories then
  316.            that would count as 4 FMS total.  One for the 'MASTER.DIR' and
  317.    
  318.  
  319.  
  320.    ■ RBBS-PC Turbo FMS Duplicate Checker v1.10                            5
  321.    ──────────────────────────────────────────────────────────────────────────
  322.  
  323.            three more for the chains.  This example configuration would only
  324.            require 1 FMS_Directory configuration keyword as the Master and
  325.            all of it's Chains are considered 1 directory, yet there are 4
  326.            physical files and therefore would count towards the 50 directory
  327.            limit.
  328.  
  329.  
  330.    2.  Fidx_Def         (Max - 01)
  331.  
  332.        The 'Fidx_Def' Keyword is used to  define the full  name and path to
  333.        the FIDX.DEF File you wish to process.  This file must be related to
  334.        the FMS directory to be processed or the dupe list may be very long.
  335.        If you are not using the Fast File Search feature of RBBS and do not
  336.        have less than 20 D/L directories to process this program will be of
  337.        no use to you as it was designed to work with the FFS System.
  338.  
  339.        Ex. Fidx_Def        C:\Rbbs\Dirr\Fidx.Def
  340.  
  341.  
  342.    3.  Lidx_Def         (Max - 01)
  343.  
  344.        The 'Lidx_Def' Keyword is used to  define the full  name and path to
  345.        the corresponding LIDX.DEF File.  This will be used in the reporting
  346.        process to give you the exact locations of duplicate files.
  347.  
  348.        Ex. Lidx_Def        C:\Rbbs\Dirr\Lidx.Def
  349.  
  350.  
  351.    4.  Sort_Prog        (Max - 01)
  352.  
  353.        The 'Sort_Prog' Keyword is used to  define the full name and path to
  354.        the sorting program you wish to have RTFDC use to do it's sorting.
  355.        RTFDC doesn't do it's own sorting!  The Sort program you choose must
  356.        take the following command line arguments:  ProgName <source> <dest>
  357.        The Sort programs that have been tested are: Qsort.Exe and Sortf.Com
  358.        If Qsort is used Version 3.04 or higher is required. If Sorf is used
  359.        Version 2.57 or higher is required. The sorting program bundled with
  360.        DOS will not work with RTFDC.  Other versions of the above mentioned
  361.        sort programs may work, but the above mention versions were tested.
  362.  
  363.        Ex. Sort_Prog       C:\Work\qsort.exe
  364.  
  365.  
  366.      Optional Keywords:   These are keywords that are designed to enhance the
  367.        operation of RTFDC and are considered optional.  The absence of any of
  368.        these keywords will not affect the operation of RTFDC in the least.
  369.  
  370.      Proc_Level      - Selects the level of Processing and Reporting.
  371.      Priv_Dir        - Full Path and FileName to the Private Directory.
  372.      Extra_Dir       - Directories not processed by the MakeFidx program.
  373.      Exclude_Dir     - Directories to be excluded from the reporting Process.
  374.      Ver_Comp        - Upgrade Version detection and reporting.
  375.  
  376.  
  377.    1. Proc_Level       (1,2,3,4)  Default = 4
  378.  
  379.       The 'Proc_Level' Keyword is used to define the level of processing to
  380.       be performed by RTFDC.  Each level will perform the  function of that
  381.    
  382.  
  383.  
  384.    ■ RBBS-PC Turbo FMS Duplicate Checker v1.10                            6
  385.    ──────────────────────────────────────────────────────────────────────────
  386.  
  387.       level and ALL levels under it.   ie.  If Level 2 processing is chosen
  388.       Level 1 and 2 processing will be performed.  If Level 3 processing is
  389.       chosen Levels 1, 2, and 3 processing will be performed.
  390.  
  391.       1.  Create a List of all possible Upgraded File versions.
  392.       2.  Create a List of any Duplicate entries in the FMS Directory(s).
  393.       3.  Create a List of any Duplicate Files on your Disk(s).
  394.       4.  Create a List of Files in your FMS but not on your Disk(s).
  395.       5.  Create a List of Files on your Disk(s) but not in your FMS.
  396.  
  397.       Ex. Proc_Level 5
  398.  
  399.  
  400.    2. Priv_Dir         (Max - 01)
  401.  
  402.       The 'Priv_Dir' Keyword is used to define the full  name and  path to
  403.       you RBBS "Private Directory."  This will be used to locate duplicate
  404.       entries in the  corresponding FMS  directories to be  processed.  It
  405.       will also determine if any files listed in the Private directory are
  406.       not located on a specified D/L drive.
  407.  
  408.       Ex. Priv_dir        C:\Rbbs\Priv\Priv.Def
  409.  
  410.  
  411.    3. Extra_Dir        (Max - 20)
  412.  
  413.       The 'Extra_Dir' Keyword is used to  define up  to a Max of 20  other
  414.       directories to process.  These will be directories not listed in the
  415.       FIDX.DEF File, or if you  are not  using the FFS and wish to process
  416.       only 20 directories. Each Directory must have it's own keyword or it
  417.       will not be processed.  A File Mask is required for this keyword.
  418.       ie. If you want all .ZIP files to be processed ONLY use *.ZIP
  419.           If you want ALL Files to be processed use *.*
  420.  
  421.       Ex. Extra_Dir       E:\Rbbs\Upld\*.*
  422.  
  423.  
  424.    4. Exclude_Dir      (Max - 05)
  425.  
  426.       The 'Exclude_Dir' Keyword is used to define any disk directory that
  427.       you wish to Exclude from the duplicate reporting process.  This can
  428.       be useful if you have a directory full of Zero  byte files used to
  429.       stop people from uploading specific files.  You would not want said
  430.       directories included in the reporting process.  Use this Keyword to
  431.       avoid unnecessary reporting.
  432.  
  433.       Ex. Exclude_Dir     P:\DUPES\1\
  434.  
  435.    5. Ver_Comp         (2 - 7)
  436.  
  437.       The 'Ver_Comp' Keyword is used to define the number of characters in
  438.       filenames to use to determine if it is a possible version upgrade. This
  439.       feature will do a literal comparison of 'x' number of characters of all
  440.       of the filenames and create a listing of it's findings
  441.  
  442.       Ex. Ver_Comp        6
  443.  
  444.           If the above example were used and RTFDC came across the following
  445.    
  446.  
  447.  
  448.    ■ RBBS-PC Turbo FMS Duplicate Checker v1.10                            7
  449.    ──────────────────────────────────────────────────────────────────────────
  450.  
  451.           filenames it would report them as possible version updates.
  452.  
  453.             Ex. RTMBP301.ZIP,  RTMBP302.ZIP  Since the first 6 characters of
  454.             the filenames are the same RTFDC assumes that this may be a
  455.             version update and reports them accordingly.  Although this is
  456.             not the most accurate detection method in the world it works in
  457.             many cases.
  458.  
  459.  
  460.    ╓──────────────────────────────────────────────────────────────────────╖
  461.    ║                           THE REPORT FILE                            ║
  462.    ╙──────────────────────────────────────────────────────────────────────╜
  463.  
  464.    The following is an example of RTFDC's Output Report File.
  465.  
  466.  
  467.    List of Files Found on the Disk(s) but NOT Found in the FMS
  468.  
  469.    [ FileName ]---[ Directory ]--------------------------------------------
  470.    $4SCHOOL.ZIP   G:\FILES\1\
  471.    4SQ11.ZIP      G:\FILES\6\
  472.    ADULT.ZIP      E:\RBBS\DNLD\
  473.    ARC600.EXE     E:\RBBS\
  474.    ARENA10.ZIP    G:\FILES\6\
  475.  
  476.    List of Files Found in the FMS but NOT Found on the Disk(s)
  477.  
  478.    [ FileName ]---[ FMS Listing     ]--------------------------------------
  479.    #2KEEN2.ZIP    C:\RBBS\DIRR\MASTER.DIR
  480.    123QB11.ZIP    C:\RBBS\DIRR\CHAIN91.DIR
  481.    174-NEW.ZIP    C:\RBBS\DIRR\MASTER.DIR
  482.  
  483.    List of Duplicate Files Found on the Disk(s)
  484.  
  485.    [ FileName ]---[ Path One ]--------------------[ Path Two ]-------------
  486.  
  487.  
  488.    List of Duplicate Entries in your File Listing
  489.  
  490.    [ FileName ]---[ Path One ]--------------------[ Path Two ]-------------
  491.    174-NEW.ZIP    C:\RBBS\DIRR\MASTER.DIR         C:\RBBS\DIRR\MASTER.DIR
  492.    174-NEW.ZIP    C:\RBBS\DIRR\MASTER.DIR         C:\RBBS\PRIV\PRIV.DEF
  493.    174DOCWP.ZIP   C:\RBBS\DIRR\MASTER.DIR         C:\RBBS\PRIV\PRIV.DEF
  494.    ALIAS174.ZIP   C:\RBBS\DIRR\MASTER.DIR         C:\RBBS\PRIV\PRIV.DEF
  495.  
  496.    List of Duplicate Versions Found on the Disk(s)
  497.  
  498.    [ FileName ]---[ Path to File ]----------------------------------------
  499.    RTMBP301.ZIP   E:\RBBS\DNLD\
  500.    RTMBP302.ZIP   E:\RBBS\UPLD\
  501.  
  502.    DSZ0412.ZIP    F:\RBBS\DSZ\
  503.    DSZ0414.ZIP    F:\RBBS\DSZ\
  504.  
  505.  
  506.  
  507.  
  508.  
  509.    
  510.  
  511.  
  512.    ■ RBBS-PC Turbo FMS Duplicate Checker v1.10                            8
  513.    ──────────────────────────────────────────────────────────────────────────
  514.  
  515.    ╓───────────────────────────────────────────────────────────────────────╖
  516.    ║                                APPENDIX                               ║
  517.    ╙───────────────────────────────────────────────────────────────────────╜
  518.  
  519.  
  520.    If you uncover  a problem with  the operation of  this program please
  521.    contact the author using one of the following methods.
  522.  
  523.       1)  BBS     - The GreyHawk BBS  Node 1 (410)461-9943 USR DS V.32Bis
  524.                                       Node 2 (410)465-3891 USR DS V.32Bis
  525.  
  526.       2)  USPS    - Walter C. Ames
  527.                     3126 Wheaton Way
  528.                     Ellicott City, MD 21043
  529.  
  530.       3)  NetMail - RelayNet ->GREYHAWK  R/O Capable
  531.                     FidoNet 1:261/1116 or 1:261/1117
  532.                     RBBSNet 8:936/203  or 8:936/204
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.    
  574.